package com.zp.service;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.service.IService;
import com.zp.domain.entity.User;
import com.zp.domain.request.user.UserQueryRequest;
import com.zp.domain.vo.CaptchaVO;
import com.zp.domain.vo.LoginUserVO;
import com.zp.domain.vo.UserVO;

import javax.servlet.http.HttpServletRequest;
import java.util.List;


public interface UserService extends IService<User> {

    /**
     * 用户注册
     *
     * @param userEmail 用户邮箱
     * @param codeKey   验证码 key
     * @param codeValue 验证码 value
     */
    long userRegister(String userEmail, String codeKey, String codeValue);

    /**
     * 用户登录
     *
     * @param userAccount  用户账号
     * @param userPassword 用户密码
     * @param captchaKey   图形验证码 key
     * @param captchaCode  图形验证码 验证码
     * @param request      存储登录信息到 session
     * @return 登录用户信息(脱敏)
     */
    LoginUserVO userLogin(String userAccount, String userPassword, String captchaKey, String captchaCode, HttpServletRequest request);

    /**
     * 获取当前登录用户
     *
     * @param request 用户的登录态
     * @return 当前登录用户
     */
    User getLoginUser(HttpServletRequest request);

    /**
     * 密码加密
     *
     * @param userPassword 密码
     * @return 加密后的密码
     */
    String encryptPassword(String userPassword);

    /**
     * 获取用户信息(脱敏)
     *
     * @param user 用户信息
     * @return 脱敏后的用户信息
     */
    LoginUserVO getLoginUserVO(User user);

    /**
     * 用户注销
     *
     * @param request 用户登录态
     * @return 是否注销成功
     */
    boolean userLogout(HttpServletRequest request);

    /**
     * 获取用户信息(脱敏)
     *
     * @param user 用户信息
     * @return 脱敏后的用户信息
     */
    UserVO getUserVO(User user);

    /**
     * 获取用户列表(脱敏)
     *
     * @param userList 用户列表
     * @return 脱敏后的用户列表
     */
    List<UserVO> getUserVOList(List<User> userList);

    /**
     * 分页查询条件构造
     *
     * @param queryRequest 查询参数
     * @return 查询条件
     */
    QueryWrapper<User> getQueryWrapper(UserQueryRequest queryRequest);

    /**
     * 判断是否为管理员
     *
     * @param user 用户
     * @return 是否为管理员
     */
    boolean isAdmin(User user);

    /**
     * 根据用户邮箱判断用户是否存在
     *
     * @param userEmail 用户邮箱
     * @return 用户是否存在
     */
    boolean queryUserByEmail(String userEmail);

    /**
     * 根据用户邮箱查询用户
     *
     * @param userEmail 用户邮箱
     * @return 用户信息
     */
    User getUserByUserEmail(String userEmail);

    /**
     * 发送邮箱验证码
     *
     * @param userEmail 用户邮箱
     * @return 验证码 key
     */
    String sendEmailCode(String userEmail);

    /**
     * 获取图形验证码
     *
     * @return 图形验证码
     */
    CaptchaVO getCaptcha();
}
